Skip to content

feat: Added FAQ page #2699

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 5 commits into
base: flutter
Choose a base branch
from
Open

feat: Added FAQ page #2699

wants to merge 5 commits into from

Conversation

Yugesh-Kumar-S
Copy link

@Yugesh-Kumar-S Yugesh-Kumar-S commented May 22, 2025 •
edited
Loading

feat: Ported FAQ as part of issue #2698

Changes

  • Implemented the FAQ route with questions in the PSLab flutter app

Screenshots / Recordings

Screen.Recording.2025-05-23.000016.mp4

Checklist:

  • No hard coding: I have used resources from strings.xml, dimens.xml and colors.xml without hard coding any value.
  • No end of file edits: No modifications done at end of resource files strings.xml, dimens.xml or colors.xml.
  • Code reformatting: I have reformatted code and fixed indentation in every file included in this pull request.
  • No extra space: My code does not contain any extra lines or extra spaces than the ones that are necessary.

Summary by Sourcery

Add a fully functional FAQ page to the app, complete with data model, UI layout, routing, and external link support.

New Features:

  • Add FAQ screen with expandable question-answer list and tappable external links
  • Introduce FAQItem model to encapsulate FAQ entries with optional links
  • Register /faq route and integrate navigation entry in the main drawer

Enhancements:

  • Use MainScaffold and ListView.separated for consistent FAQ layout and theming
  • Implement URL launching for FAQ links
  • Update navigation drawer to handle routing to the FAQ screen gracefully

@sourcery-ai Sourcery AI
Copy link

sourcery-ai bot commented May 22, 2025 •
edited
Loading

Reviewer's Guide

Introduces a new FAQ page implemented as a stateless widget that loads a static list of question–answer items with optional links via ExpansionTiles, adds URL launch support, and integrates the new screen into the app’s route map and navigation drawer.

File-Level Changes

Change Details Files
Implemented the FAQScreen UI with dynamic content and link handling
  • Imported Material, custom colors, constants, MainScaffold widget, and url_launcher library
  • Defined FAQItem model and static list of FAQs with question, answer, and optional link fields
  • Replaced unimplemented build method to render MainScaffold containing a ListView of ExpansionTiles
  • Created private _buildFAQItem and _launchURL methods for rendering Q/A rows and opening external URLs
 lib/view/faq_screen.dart
Integrated the FAQ page into app navigation
  • Updated navigation_drawer.dart to handle tap on FAQ entry with proper push/pop to '/faq'
  • Added '/faq' route mapping in main.dart’s routes table
  • Cleaned up import ordering and whitespace in main.dart
 lib/view/widgets/navigation_drawer.dart
lib/main.dart
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@marcnause marcnause changed the title Added FAQ page feat: Added FAQ page May 22, 2025
@github-actions GitHub Actions
Copy link

github-actions bot commented May 25, 2025 •
edited
Loading

Build successful. APKs to test: https://github.com/fossasia/pslab-android/actions/runs/15361969783/artifacts/3233515190

@AsCress AsCress self-requested a review May 26, 2025 02:22
@mariobehling mariobehling requested a review from adityastic May 30, 2025 09:35
AsCress
AsCress requested changes May 31, 2025
View reviewed changes
@Yugesh-Kumar-S Yugesh-Kumar-S requested a review from AsCress May 31, 2025 08:48
@AsCress
Copy link
Collaborator

AsCress commented May 31, 2025

@Yugesh-Kumar-S Nice addition ! I'll get back to this PRs and your others after testing the responsiveness of the layouts. We need to make sure that we implement responsive layouts in the app.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mariobehling mariobehling mariobehling approved these changes

@adityastic adityastic Awaiting requested review from adityastic

@AsCress AsCress Awaiting requested review from AsCress

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Yugesh-Kumar-S @AsCress @mariobehling